PortOne Server SDK for JVM/io.portone.sdk.server.platform.payout

Package-level declarations

Types

@Serializable

class PayoutClient(apiSecret: String, apiBase: String = "https://api.portone.io", storeId: String? = null) : Closeable

API Secret을 사용해 포트원 API 클라이언트를 생성합니다.

@Serializable

data class PlatformPayout(val id: String, val graphqlId: String, val bulkPayoutId: String, val bulkPayoutGraphqlId: String, val method: PlatformPayoutMethod, val status: PlatformPayoutStatus, val statusUpdatedAt: @Serializable(with = InstantSerializer::class) Instant, val memo: String? = null, val partner: PlatformPartner, val account: PlatformPayoutAccount, val taxInvoiceId: String? = null, val taxInvoiceStatus: PlatformPayoutTaxInvoiceStatus, val currency: Currency, val amount: Long, val supplyAmount: Long, val taxFreeAmount: Long, val vatAmount: Long, val settlementAmount: Long, val settlementTaxFreeAmount: Long, val incomeTaxAmount: Long, val localIncomeTaxAmount: Long, val withdrawalMemo: String? = null, val depositMemo: String? = null, val createdAt: @Serializable(with = InstantSerializer::class) Instant, val scheduledAt: @Serializable(with = InstantSerializer::class) Instant? = null, val failReason: String? = null, val deductWht: Boolean, val settlementAmountType: SettlementAmountType, val settlementStatement: PlatformPayoutSettlementStatementSummary)

@Serializable

data class PlatformPayoutAccount(val bank: Bank, val number: String, val holder: String)

@Serializable

data class PlatformPayoutFilterInput(val statuses: List<PlatformPayoutStatus>? = null, val partnerIds: List<String>? = null, val criteria: PlatformPayoutFilterInputCriteria, val payoutAccountBanks: List<Bank>? = null, val partnerTags: List<String>? = null, val payoutCurrencies: List<Currency>? = null, val payoutIds: List<String>? = null, val taxInvoiceStatuses: List<PlatformPayoutTaxInvoiceStatus>? = null, val partnerTypes: List<PlatformPartnerTypeName>? = null, val partnerTaxationTypes: List<PlatformPartnerTaxationType>? = null, val settlementStatementStatuses: List<PlatformPayoutSettlementStatementStatus>? = null)

지급 내역 필터 입력 정보

@Serializable

data class PlatformPayoutFilterInputCriteria(val timestampRange: DateTimeRange? = null, val statusUpdatedTimestampRange: DateTimeRange? = null, val scheduledTimestampRange: DateTimeRange? = null, val settlementStatementIssuedTimestampRange: DateTimeRange? = null, val payoutId: String? = null, val bulkPayoutId: String? = null, val taxInvoiceId: String? = null, val settlementStatementId: String? = null)

검색 기준 입력 정보

@Serializable(with = PlatformPayoutSettlementStatementStatusSerializer::class)

정산 내역서 발송 상태

@Serializable

data class PlatformPayoutSettlementStatementSummary(val status: PlatformPayoutSettlementStatementStatus, val id: String? = null, val issuedAt: @Serializable(with = InstantSerializer::class) Instant? = null)

정산 내역서 요약 정보

@Serializable(with = PlatformPayoutStatusSerializer::class)

@Serializable(with = PlatformPayoutTaxInvoiceStatusSerializer::class)